home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Users Group Library 1996 July / C-C++ Users Group Library July 1996.iso / vol_200 / 295_01 / blkio.rme < prev    next >
Text File  |  1989-12-28  |  9KB  |  261 lines
  1. ----------------------------------------------------------------------
  2. | Citadel                                                            |
  3. | 241 East Eleventh Street * Brookville, IN 47012 * 317-647-4720     |
  4. |                                               BBS 317-647-2403     |
  5. ----------------------------------------------------------------------
  6.  
  7. blkio is distributed in a single compressed file blkioRL.zip; R and L
  8. would be the release and level numbers, respectively.  The ZIP data
  9. compression utilities are needed to extract the individual files.
  10.  
  11. The following files are obtained by decompressing blkioRL.zip:
  12.  
  13.    blkio.rme  preliminary information
  14. rlsnotes.txt  release notes
  15.        *.h    blkio header files
  16.        *.c    blkio source files
  17.    blkio.rsp  Borland response file for building the library
  18.  install.bat  MS-DOS installation batch file
  19. makefile      UNIX makefile
  20.   manxRL.zip  manual entry extraction utility
  21.  
  22. The original file blkioRL.zip should be saved if you wish to pass on
  23. copies of blkio.  blkio may not be distributed as individual files, or
  24. in an incomplete or altered form.
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.                                                         Citadel  89-10
  53. ----------------------------------------------------------------------
  54. | blkio - block buffered i/o library                                 |
  55. | Version 1.1                                                        |
  56. ----------------------------------------------------------------------
  57.  
  58. BLKIO
  59.  
  60. The blkio library is a buffered input/output library for C similar to
  61. the stdio library but designed for use with structured files.  The LRU
  62. (least recently used) replacement algorithm is used for buffering.
  63. The reference manual is embedded in the source code (see INSTALLATION
  64. INSTRUCTIONS).  For additional information on using the library, see
  65. the article "A Buffered I/O Library for Structured Files" in the
  66. October 1989 issue (volume 7 number 7) of "The C Users Journal."
  67. Technical support for the blkio library can be obtained on the Citadel
  68. BBS.
  69.  
  70. The blkio library is a component of cbase, a C database library
  71. developed at Citadel.  The current version of cbase as well as blkio
  72. can be downloaded from the Citadel BBS.
  73.  
  74. ======================================================================
  75. COPYRIGHT
  76.  
  77. Copyright (c) 1989 Citadel.
  78.  
  79. The blkio library has been released into the public domain subject to
  80. the following restrictions:
  81.      - No fee is charged for use, copying, or distribution.
  82.      - It may not be distributed in an incomplete or altered
  83.        form.  This file is included in these restrictions.
  84.      - Clubs and user groups may charge a nominal fee not to exceed
  85.        $10 for expenses and handling while distributing blkio.
  86.  
  87. These restrictions are in no way intended to discourage the use of
  88. this library for commercial packages.
  89.  
  90. ======================================================================
  91. DISCLAIMER
  92.      Citadel hereby disclaims all warranties relating to this
  93.      software, whether express or implied, including without
  94.      limitation any implied warranties of merchantibility or fitness
  95.      for a particular purpose.  Citadel shall not be liable to anyone
  96.      for any special, incidental, consequential, indirect, or similar
  97.      damages due to loss of data or any other reason, even if Citadel
  98.      or an agent of Citadel has been advised of the possibility of
  99.      such damages.
  100.  
  101. ======================================================================
  102.  
  103.  
  104.                                                         Citadel  89-10
  105. INSTALLATION INSTRUCTIONS
  106.  
  107. To select the host operating system, set the HOST macro in the private
  108. header file blkio_.h.  The modifications necessary to port cbase to a
  109. new operating system are straightforward, consisting mostly of direct
  110. translations of system calls such as open, close, and lseek.  All
  111. operating system dependent code is located in the files buops.c and
  112. lockb.c.
  113.  
  114. If using MS-DOS, also set the MSDOSC macro in blkio_.h to the C
  115. compiler being used.  The modifications necessary to port to a new C
  116. compiler should be minimal, consisting only of translations of header
  117. file names and macro names such as those used by open and lseek.
  118.  
  119. Because of the lack of uniformity among MS-DOS C compilers, exact
  120. installation procedures for this operating system vary.  The supplied
  121. batch file install.bat is written for Borland Turbo C.  Instructions
  122. for modifying this batch file for other compilers are given at the
  123. beginning of install.bat
  124.  
  125. Before proceeding, the manx utility must be installed.
  126.  
  127.  
  128.                             UNIX
  129.      1. Install the boolean header file.
  130.              $ su
  131.              # cp bool.h /usr/include
  132.              # ^D
  133.      2. Extract and print the reference manual.
  134.              $ make man
  135.              $ lp blkio.man
  136.      3. Build the blkio library.  (Examine the makerec file
  137.         afterward for warnings.)
  138.              $ make blkio > makerec
  139.      4. Install the blkio library.  This will copy the blkio
  140.         header file blkio.h to /usr/include and the blkio
  141.         library archive to /usr/lib.
  142.              $ su
  143.              # make install
  144.              # ^D
  145.  
  146.                            MS-DOS
  147.      1. If necessary, modify install.bat for the C compiler
  148.         being used.
  149.      2. Install the blkio library and print the reference manual.
  150.              > install
  151.              > print blkio.man
  152.  
  153. ======================================================================
  154.  
  155.  
  156.                                                         Citadel  89-10
  157. ----------------------------------------------------------------------
  158. | cbase - C database library                                         |
  159. | Version 1.0                                                        |
  160. ----------------------------------------------------------------------
  161.  
  162. cbase is a C database file management library.  B+-trees are used for
  163. indexed and sequential record access.  cbase features a truly modular
  164. design and provides a logical and consistent interface.  The figure
  165. below shows the individual libraries included with cbase and their
  166. relationships.  Each of these is complete and may be used
  167. independently.
  168.  
  169.                  -----------------------------------
  170.                  |              cbase              |
  171.                  -----------------------------------
  172.                          |                 |
  173.                  ----------------- -----------------
  174.                  |     lseq      | |     btree     |
  175.                  ----------------- -----------------
  176.                          |                 |
  177.                  -----------------------------------
  178.                  |              blkio              |
  179.                  -----------------------------------
  180.  
  181.                     cbase and Underlying Libraries
  182.  
  183.      cbase - C database library
  184.      btree - B+-tree file management library
  185.      lseq  - doubly linked sequential file management library
  186.      blkio - block buffered i/o library
  187.  
  188. Extremely portable:
  189.   - Written in strict adherence to ANSI C standard.
  190.   - K&R C compatibility maintained.
  191.   - All operating system dependent code is isolated to a small portion
  192.     of the blkio library to make porting to new systems easy.
  193.   - All source code is included.
  194.   - UNIX and MS-DOS currently supported.*
  195. Completely buffered:
  196.   - Both records and indexes are buffered using LRU (least recently
  197.     used) buffering.
  198. Fast and efficient sequential access:
  199.   - Records are stored in doubly linked lists for non-keyed sequential
  200.     access.
  201.   - Indexes are stored in B+-trees to allow keyed sequential access.
  202.   - Both types of sequential access are bidirectional.
  203. Fast and efficient random access:
  204.   - B+-trees are used for inverted file key storage.
  205.   - Multiple keys are supported.
  206.   - Both unique and duplicate keys are supported.
  207.  
  208.                                                         Citadel  89-10
  209. Multiuser:
  210.   - Read-only locking.
  211. Other:
  212.   - Easy to add custom data types.